/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.security.authorization.testwikibuilding;

import com.xpn.xwiki.doc.XWikiDocument;

/**
 * This interface is used for building a mocked test setup for testing the authorization manager. Interface for entities
 * that contain documents. I.e., a space.
 * 
 * @since 4.2
 * @version $Id$
 */
public interface HasDocuments extends HasAcl
{
    /**
     * @param name The name of the document to add.
     * @param creator The name of the creator. May be {\code null}.
     * @param alt The pretty name of the document. (optional)
     * @return an entity representing the document that holds the acl of the document.
     */
    HasAcl addDocument(String name, String creator, String alt);

    /**
     * @param name The name of the document to add.
     * @param creator The name of the creator. May be {\code null}.
     * @param enforceRequiredRights whether to enforce required rights on the document.
     * @param alt The pretty name of the document. (optional)
     * @return an entity representing the document that holds the acl of the document.
     */
    HasAcl addDocument(String name, String creator, boolean enforceRequiredRights, String alt);


    XWikiDocument removeDocument(String name);
}
